TextSnapshot.getText()

Доступность

Среда разработки: Flash MX 2004.

Плеер: SWF файлы, опубликованные для Flash Player 6 или более поздних версий, проигрываются во Flash Player 7 и более поздних.

Синтаксис

my_snap.getText(from:Number, to:Number [, includeLineEndings:Boolean ] ) : String

Параметры

from Число, отражающее позицию первого символа в тексте объекта my_snap, который будет включен в возвращаемую строку. Допустимыми значениями для параметра from являются значения от 0 до TextSnapshot.getCount() - 1. Если параметру from передать отрицательное значение, будет использоваться 0.

to Число, на единицу большее индекса последнего символа в объекте my_snap, который будет проверен. Корректными значениями для to являются значения от 0 до TextSnapshot.getCount(). Символ с индексом, указанным в параметре to, не включается в обрабатываемую строку. Если данный параметр опущен, используете величина, возвращаемая методом TextSnapshot.getCount(). Если значение данного параметра меньше или равно, чем значение параметра from, используется значение from+1.

includeLineEndings необязательная булева величина, показывающая, добавляются ли к строке символы перевода строки. Значением по умолчанию является false.

Возвращает

Строка, создержащая символы в указанном диапазоне или пустую строку, если в указанном диапазоне символов не содержится.

Описание

Метод; возвращает строку, содержащую все символы, определенные параметрами from и to. Если выделенных символов нет, возвращается пустая строка.

Для проверки всех символов, передайте величину 0 параметру from и TextSnapshot.getCount() (или любое большее число) параметру to. Для проверки одного символа, передайте значение, равное значению параметра from+1 параметру to.

Если вы передаете параметру includeLineEndings значение true, в строку, если это необходимо, вставляются символы переноса строки. В этом случае возвращаемая строка может быть длиннее, чем максимальное количество, разрешенное для ввода в текстовое поле. Если includeLineEndings передано значение false или опущен, выделенный текст возвращается без добавления символов.

Пример

Код в нижеследующем примере показывает, как вы можете узнать число символов в определенном объекте TextSnapshot. Перед использованием этого кода, разместите на Сцене статическое текстовое поле с текстом “TextSnapshot Example”.

// В этом примере предполагается, что мувиклип содержит
// статическое текстовое поле с текстом "TextSnapshot Example"
var my_mc:MovieClip = this;
var my_snap:TextSnapshot = my_mc.getTextSnapshot();
var count:Number = my_snap.getCount();
var theText:String = my_snap.getText(0, count, false);
trace(count); // выводит: 20
trace(theText); // выводит: TextSnapshot Example

См. также

TextSnapshot.getSelectedText()

Посмотреть комментарии LiveDocs

Предыдущая | Следующая | Оглавление